Get Customer Numbers

This request retrieves the numbers that are assigned to a specific customer tenant. Numbers can be viewed in the Number Management page of the Multitenant portal (see Operator Connect Number Management).

URI

Copy 
{{baseUrl}}/api/v2/oc/numbers?msTenantId={{msTenantId}}

HTTP Method

GET

Request Parameters

Parameter

Type

Description

msTenantId

string

Customer's Microsoft Azure Tenant Subscription Id.

Example Response

Copy 
[
    {
        "uploadTelephoneNumberEntryId": 324930,
        "source": "webapi",
        "sbcList": [
            {
                "sbcName": "oc1.sandbox2.audiocodes.be [20.102.51.206]",
                "sbcId": 8
            }
        ],
        "id": 125336,
        "uploadToAccountJobId": 3103,
        "whenCreated": "2024-04-04T12:24:01.9697859+00:00",
        "acquiredNumberStatus": null,
        "telephoneNumber": "+18333998785",
        "callingProfileId": "5f3fbb3b-df9b-483d-b294-c7eb01e22aac",
        "acquiredCapabilities": [
            "TollFree",
            "FirstPartyAppAssignment",
            "Office365",
            "InboundCalling",
            "OutboundCalling"
        ],
        "availableCapabilities": [
            "TollFree",
            "FirstPartyAppAssignment",
            "Office365",
            "InboundCalling",
            "OutboundCalling"
        ],
        "acquiredOn": "2024-04-04T12:21:56.6005305+00:00",
        "isoCountryCode": "US",
        "tnUploadJobId": "a0049837-d57d-4806-b96d-e590143106ad",
        "locationId": null,
        "civicAddressId": null,
        "assignmentStatus": null,
        "tenantId": "f94238e5-4f2c-4e1b-8125-2d27122ca75f",
        "aslcht": null,
        "aslsct": null,
        "aslvCode": null,
        "asticks": null
    },
    {
        "uploadTelephoneNumberEntryId": 324931,
        "source": "webapi",
        "sbcList": [
            {
                "sbcName": "oc1.sandbox2.audiocodes.be [20.102.51.206]",
                "sbcId": 8
            }
        ],
        "id": 125337,
        "uploadToAccountJobId": 3104,
        "whenCreated": "2024-04-04T13:24:20.5229594+00:00",
        "acquiredNumberStatus": null,
        "telephoneNumber": "+61397508869",
        "callingProfileId": "5f3fbb3b-df9b-483d-b294-c7eb01e22aac",
        "acquiredCapabilities": [
            "Office365",
            "InboundCalling",
            "OutboundCalling",
            "UserAssignment"
        ],
        "availableCapabilities": [
            "Office365",
            "InboundCalling",
            "OutboundCalling",
            "UserAssignment",
            "Mobile"
        ],
        "acquiredOn": "2024-04-04T13:20:54.0070492+00:00",
        "isoCountryCode": "AU",
        "tnUploadJobId": "136c1761-77a7-4a81-b541-9d42bb6d7c03",
        "locationId": null,
        "civicAddressId": null,
        "assignmentStatus": null,
        "tenantId": "f94238e5-4f2c-4e1b-8125-2d27122ca75f",
        "aslcht": null,
        "aslsct": null,
        "aslvCode": null,
        "asticks": null
    }
]

HTTP Responses

■ 200 OK

Parameter

Type

Description

uploadTelephoneNumberEntryId

string

 Unique identifier of the uploaded number.

source

string

 Source interface of the uploaded number; webapi

sbcList

list array

List array including the following parameters:

■ sbcName
■ sbcId

sbcName

string

 SBC FQDN and IP address, For example, oc1.sandbox2.audiocodes.be \[xx.xxx.xx.xxx\]

sbcId

integer

 SBC Id in Live Cloud database.

id

integer

 Job Id for the retrieval of the specific number.

uploadToAccountJobId

integer

 Job Id indicating when the number was uploaded.

whenCreated

string($date-time)

 Timestamp at the commencement of the number retrieval.

telephoneNumber

string

List of retrieved telephone numbers.

callingProfileId

string

The Id of the attached Calling Profile. Calling profiles are attached by AudioCodes Professional Services.

acquiredCapabilities

string

Capabilities acquired from the Calling profile. One of the following values:

■ TollFree
■ FirstPartyAppAssignment
■ Office365
■ InboundCalling
■ OutboundCalling
■ UserAssignment
■ Mobile

availableCapabilities

string

Capabilities available for configuration in the Calling profile. One of the following values:

■ TollFree
■ FirstPartyAppAssignment
■ Office360
■ InboundCalling
■ OutboundCalling
■ UserAssignment
■ Mobile

acquiredOn

string($date-time)

Timestamp indicating when the number was uploaded to customer tenant.

isoCountryCode

string

Country Calling dial code configured by customer in Teams admin center. See Country Dialing Codes for a full list of Dialing codes.

tnUploadJobId

string

Id for upload to customer account.

locationId

string

Id of the site location (see Get Services Brief Details (V3).

civicAddressId

string

Id of the civicAddress (see Get All OC Leads).

assignmentStatus

list

Indicates the type of number assignment in the Teams admin center:

■ UserAssigned: Assign number directly to a user.
■ ConferenceAssigned: Assign Service number to an Audio conferencing bridge.
■ VoiceApp: Assign Service number to an Auto attendant or Call queue.
■ ThirdPartyAppAssigned

tenantId

string

Customer tenant Azure subscription tenant Id.

aslcht

string($date-time)

Last successful assignment check time, updated each time after a successful verification.

If there are errors, do not update this field, and do not touch the status itself.

alsvcode

string

Last verification code, numeric, inspired from http status codes:

■ 200 OK
■ 500, 404
■ Set to null in case of never verified

aslcht

string($date-time)

Last status change time (null if not known).

asticks

string($date-time)

Ticks for the iteration session.